[Top] [Prev] [Next] [Bottom]
[Contents]
Code / Project Structure
A project generated by Sapphire/Web consists of the files listed below.
This file contains information about the entire project. It has the names of all of the HTML files, the names of the module files, and all of the project-specific options. The filename of this file is project_name.pj.
This file is generated by Sapphire/Web when the project is saved. The contents of this file comes from the makefile template located in $SAPPHIRE/config/Makefile.tem and values from your project file. The makefile is generated by Sapphire/Web but is never read by the tool. If you make changes directly to the generated makefile, they will be lost the next time your project is saved. If you need to change the contents of the makefile you should either change some of the project options using the Options Editor or modify the makefile template.
- Note: If you change the makefile template, all projects will get that change in their makefile the next time a project is saved. The file is named
-
project_name.mak
HTML Files
When an HTML file is added to a project, the file is first copied to the current directory. Another copy of the HTML file is placed into the in_use directory as html_filename.sap. Do not touch this copy of the HTML file because it represents what the file looked like when it was loaded into Sapphire/Web and is needed to process an HTML refresh correctly. We recommend that you only edit an HTML file in the project directory either when the tool is not running, or if it is running, by clicking the Edit button in the Document Manager window.
When you create the first binding for an HTML file, a module file will be created when the project is saved. This file contains all of the code required to implement the binding(s) you have defined using Sapphire/Web. When you open a project, this file is read to determine the bindings, initial and final code for the HTML file.
- Note: We do not recommend that you modify this file outside of Sapphire/Web. You can lose information needed for the bindings if you do not follow the same rules the tool uses when generating the code. The name of this file is
{HTML name with file extension removed}.c. For example the file home.html will create a module file called home.c.
Main Module File
The main module file is created when a project is saved. The contents of this file come from the main template located in $SAPPHIRE/config/main.tem and values in your project file. When you open a project, this file is read to get the code that you entered in the Project Code interface.
- Note: If you do not follow the same rules that the tool uses when generating this file, you can lose your code. The filename of this file is
project_name.c.
Backup Directory
Sapphire/Web copies the project that is currently in the project directory to a backup directory before every save to ensure that you do not lose a whole project due to a bug in the tool, to major system problems (like a power outage or system crash), or during a save. The backup may also be used to revert back to the last saved version of the project. You can press the Revert button in the file pulldown menu in the Project Window to revert to the backup copy of the project. The name of this backup directory is sapphireBackproject_name. This directory will contain all of your HTML, Module, Make, and Project Files needed to restore your entire project.
[Top] [Prev] [Next] [Bottom]
[Contents]
info@bluestone.com
Copyright © 1997, Bluestone. All rights
reserved.